Skip to content

update systems and components docs for completeness#1954

Merged
hannahbaumann merged 4 commits into
mainfrom
docs/update_systems_and_components
Apr 24, 2026
Merged

update systems and components docs for completeness#1954
hannahbaumann merged 4 commits into
mainfrom
docs/update_systems_and_components

Conversation

@atravitz
Copy link
Copy Markdown
Contributor

@atravitz atravitz commented Apr 22, 2026

I noticed we don't have all relevant components in the api docs, so I added them here.

Might help with #1933

Checklist

  • All new code is appropriately documented (user-facing code must have complete docstrings).
  • Added a news entry, or the changes are not user-facing.
  • Ran pre-commit: you can run pre-commit locally or comment on this PR with pre-commit.ci autofix.

Manual Tests: these are slow so don't need to be run every commit, only before merging and when relevant changes are made (generally at reviewer-discretion).

Developers certificate of origin

@atravitz atravitz requested a review from hannahbaumann April 22, 2026 22:24
@atravitz atravitz mentioned this pull request Apr 22, 2026
11 tasks
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.50%. Comparing base (7959cc6) to head (41c6336).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1954      +/-   ##
==========================================
- Coverage   94.78%   90.50%   -4.29%     
==========================================
  Files         210      214       +4     
  Lines       18841    19000     +159     
==========================================
- Hits        17859    17195     -664     
- Misses        982     1805     +823     
Flag Coverage Δ
fast-tests 90.50% <ø> (?)
slow-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@hannahbaumann hannahbaumann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @atravitz , lgtm! Just the one comment!

Comment thread docs/reference/api/systems_and_components.rst
@atravitz atravitz marked this pull request as ready for review April 23, 2026 16:10
@atravitz atravitz requested a review from hannahbaumann April 24, 2026 00:07
@atravitz atravitz closed this Apr 24, 2026
@atravitz atravitz reopened this Apr 24, 2026
Copy link
Copy Markdown
Contributor

@hannahbaumann hannahbaumann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @atravitz , lgtm!

@github-actions
Copy link
Copy Markdown

No API break detected ✅

@hannahbaumann hannahbaumann merged commit 9084614 into main Apr 24, 2026
10 checks passed
@hannahbaumann hannahbaumann deleted the docs/update_systems_and_components branch April 24, 2026 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants